Fixes microsoft#25369

Problem

The Python extension's "Report Issue" command was displaying duplicate content in the VSCode issue reporter. This occurred because both the static template (report_issue_template.md) and the formatted diagnostic data (report_issue_user_data_template.md) were being passed to the VSCode issue reporter API simultaneously:

await this.commandManager.executeCommand('workbench.action.openIssueReporter', {
    extensionId: 'ms-python.python',
    issueBody: template,                // Static template with placeholders
    data: userTemplate.format(         // Formatted diagnostic data
        pythonVersion,
        virtualEnvKind,
        languageServer,
        // ... other diagnostic info
    ),
});

This resulted in users seeing both the generic issue template and the diagnostic information, leading to a confusing and cluttered issue reporting experience.

Solution

The fix preserves the structured issue template while eliminating duplication by merging the formatted diagnostic data directly into the template. The diagnostic data now replaces the XXX placeholder in the template's diagnostic section:

const formattedDiagnosticData = userTemplate.format(
    pythonVersion,
    virtualEnvKind,
    languageServer,
    hasMultipleFoldersText,
    userSettings,
    installedExtensions.join('\n'),
);

// Replace the XXX placeholder in the diagnostic data section with the formatted diagnostic data
const issueBodyWithDiagnostics = template.replace('XXX', formattedDiagnosticData);

await this.commandManager.executeCommand('workbench.action.openIssueReporter', {
    extensionId: 'ms-python.python',
    issueBody: issueBodyWithDiagnostics,
});

Changes

• reportIssueCommand.ts: Modified to merge formatted diagnostic data into the template by replacing the XXX placeholder, then pass only the combined result as issueBody
• reportIssueCommand.unit.test.ts: Updated test expectations to verify the merged template approach

This approach maintains the user guidance from the static template while ensuring diagnostic information is properly embedded without duplication.

Benefits

• Users still see the structured issue template with guidance sections
• Diagnostic data is properly embedded where expected
• No duplicate content between template and diagnostic data
• Preserves all essential diagnostic information for effective issue reporting

Testing

All existing unit tests pass, confirming that the diagnostic data formatting and issue reporter integration continue to work correctly with the new merged approach.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.